/**
 * Copyright 2006 gworks.com.au
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. (http://www.apache.org/licenses/LICENSE-2.0)
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed 
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for 
 * the specific language governing permissions and limitations under the License.
 *
 * <dhamma-message src="Atisha (11th century Tibetan Buddhist master)">
 * 	The greatest achievement is selflessness. The greatest worth is self-mastery.
 * 	The greatest quality is seeking to serve others. The greatest precept is continual awareness.
 * 	The greatest medicine is the emptiness of everything. The greatest action is not conforming with the worlds ways.
 * 	The greatest magic is transmuting the passions. The greatest generosity is non-attachment.
 * 	The greatest goodness is a peaceful mind. The greatest patience is humility.
 * 	The greatest effort is not concerned with results. The greatest meditation is a mind that lets go.
 * 	The greatest wisdom is seeing through appearances. 
 * </dhamma-message>
 */
package org.javaongems.runtime.util;

import java.util.ArrayList;
import java.util.List;
import java.util.StringTokenizer;

/**
 * <p>Provides convenient List features that are not part of the JDK or commons collections</p>
 * <p>Responsibilities:
 * <ul>
 * 	<li> convert a delimited string list (eg. comma delimited) and return it as a list
 * </ul>
 * </p>
 * 
 * <p>Collaborators:
 * <ul>
 * 	<li> {@link StringTokenizer}
 * </ul>
 * </p>
 * @author Ashin Wimalajeewa (ash)
 */
final public class ListUtils {
	private ListUtils() {
		// nothing to do
	}
	
	/**
	 * Command that converts a delimited string list into a list object
	 * @param str - the string with tokenisable delimitors
	 * @param delim - the delimiter(s) to use in tokenisation 
	 * @param trim - trim the resultant token before adding it to the list
	 * @return the list of tokens
	 */
	static public List<String> toList(String str, String delim, boolean trim) {
		ArrayList<String> ret = new ArrayList<String>();
		for (StringTokenizer tok = new StringTokenizer(str, delim); tok.hasMoreTokens();) {
			String entry = tok.nextToken();
			if (trim)
				entry = entry.trim();
			ret.add(entry);
		}
		return ret;
	}
}
